home *** CD-ROM | disk | FTP | other *** search
/ Graphics Plus / Graphics Plus.iso / libs / gle / surface.hlp < prev    next >
Encoding:
Text File  |  1992-11-29  |  6.4 KB  |  248 lines
  1.  
  2. 3 SURFACE
  3.     SURFace plots 3 dimensional data using a wire frame with
  4.     hidden line removal.
  5.     The simplist SURFACE file would look like this.
  6.         BEGIN SURFACE
  7.             DATA myfile.z 5 5
  8.         END SURFACE
  9.  
  10.     More help is available on the following topics:
  11.  
  12.     SIZE    CUBE    XAXIS    YAXIS    ZAXIS
  13.     XTITLE    YTITLE    ZTITLE  DATA    ROTATE
  14.     VIEW    TOP    UNDERNEATH    SKIRT
  15.     XLINES    YLINES     POINTS    MARKER    DROPLINES
  16.     RISELINES    HARRAY    BACK    BASE
  17.     RIGHT     TITLE   ZCLIP
  18.  
  19. 4 SIZE
  20.     Specifies the size in cm to draw the surface.  The 3d cube
  21.     will fit inside this box.  The default is 18cm x 18cm
  22.  
  23.     e.g.    SIZE 10 10
  24.  
  25. 4 HARRAY
  26.     The hidden line removal is accomplished with the help of
  27.     an array of heights which record the current horizon,  the
  28.     quality of the output is proportional to the width of this
  29.     array.  (also the speed of output)
  30.  
  31.     To get good quality you may want to increase this from
  32.     the default of about 900 to 2 or 3 thousand.
  33.  
  34.     e.g.    HARRAY 2000
  35.  
  36. 4 CUBE
  37.     CUBE  OFF  XLEN v YLEN v ZLEN v  NOFRONT LSTYLE l COLOR c
  38.  
  39.     OFF    Stops GLE from drawing the cube.
  40.     XLEN    The length of the cubes x dimension in cm.
  41.     NOFRONT    Removes the front three lines of the cube.
  42.     LSTYLE    Sets the line style to use drawing the cube.
  43.     COLOR     Sets the color of lines to use drawing the cube.
  44.  
  45. 4 XAXIS
  46.     XAXIS MIN v  MAX v  STEP v  COLOR c LSTYLE l HEI v OFF
  47.  
  48.     MIN,MAX    Set the range used for labelling the axis.
  49.     STEP    The distance between labels on the axis.
  50.     COLOR    The color of the axis ticks and labels.
  51.     LSTYLE    The line style used for drawing the ticks.
  52.     TICKLEN    The length of the ticks.
  53.     HEI    The height of text used for labelling.
  54.     OFF    Stops GLE from drawing the axis.
  55.  
  56. 4 YAXIS
  57.     YAXIS MIN v  MAX v  STEP v  COLOR c LSTYLE l HEI v OFF
  58.  
  59.     MIN,MAX    Set the range used for labelling the axis.
  60.     STEP    The distance between labels on the axis.
  61.     COLOR    The color of the axis ticks and labels.
  62.     LSTYLE    The line style used for drawing the ticks.
  63.     TICKLEN    The length of the ticks.
  64.     HEI    The height of text used for labelling.
  65.     OFF    Stops GLE from drawing the axis.
  66.  
  67. 4 ZCLIP
  68.     ZCLIP  MIN v1  MAX v2
  69.     
  70.     ZCLIP goes through the Z array and sets any Z value smaller
  71.     than MIN to V1 and sets any value greater than MAX to v2.
  72.  
  73. 4 ZAXIS
  74.     ZAXIS MIN v  MAX v  STEP v  COLOR c LSTYLE l HEI v OFF
  75.  
  76.     MIN,MAX    Set the range used for labelling the axis.
  77.         (Also sets the range of Z values)
  78.     STEP    The distance between labels on the axis.
  79.     COLOR    The color of the axis ticks and labels.
  80.     LSTYLE    The line style used for drawing the ticks.
  81.     TICKLEN    The length of the ticks.
  82.     HEI    The height of text used for labelling.
  83.     OFF    Stops GLE from drawing the axis.
  84.  
  85. 4 XTITLE
  86.     XTITLE "X title"  DIST v COLOR c HEI v
  87.  
  88.     DIST    Moves the title further away from the axis.
  89.     COLOR    Sets the color of the title.
  90.     HEI    Sets the hei in cm of the text used for the title.
  91.  
  92. 4 YTITLE
  93.     YTITLE "Y title"  DIST v COLOR c HEI v
  94.  
  95.     DIST    Moves the title further away from the axis.
  96.     COLOR    Sets the color of the title.
  97.     HEI    Sets the hei in cm of the text used for the title.
  98.  
  99. 4 ZTITLE
  100.     ZTITLE "Z title"  DIST v COLOR c HEI v
  101.  
  102.     DIST    Moves the title further away from the axis.
  103.     COLOR    Sets the color of the title.
  104.     HEI    Sets the hei in cm of the text used for the title.
  105.  
  106. 4 TITLE
  107.     TITLE "Main title"  DIST v COLOR c HEI v
  108.  
  109.     DIST    Moves the title further away from the axis.
  110.     COLOR    Sets the color of the title.
  111.     HEI    Sets the hei in cm of the text used for the title.
  112.  
  113. 4 DATA
  114.     DATA myfile.z  XSAMPLE n1 YSAMPLE n2 SAMPLE n3  NX n1 NY n2
  115.  
  116.     Loads a file of Z values in.  The NX and NY dimensions
  117.     are optional, normally the dimensions of the data will
  118.     be defined on the first line of the data file.
  119.     e.g.
  120.  
  121.     ! NX 10  NY 20    XMIN 1 XMAX 10 YMIN 1 YMAX 20
  122.     1 2 42 4 5 2 31 4 3 2 4
  123.     1 2 42 4 5 2 31 4 3 2 4 etc...
  124.  
  125.     Data files can be created using LETZ or FITZ.
  126.     LETZ will create a data file from an x,y function.
  127.     FITZ will create a data file from a list of x,y,z data points.
  128.  
  129.     XSAMPLE Tells surface to only read every n'th data point from
  130.                 the data file.  This speeds things up while you are
  131.                 messing around.        
  132.     YSAMPLE Tells surface to only read every n'th line from the 
  133.                 data file.
  134.     SAMPLE    Sets both XSAMPLE and YSAMPLE
  135.  
  136.     (see also POINTS)
  137.  
  138. 4 ROTATE
  139.     ROTATE 10 20 30
  140.  
  141.     Imagine the unit cube is sitting on the front of your
  142.     terminal screen, x along the bottom, y up the left hand
  143.     side, and z coming towards you.
  144.  
  145.     The first number (10) rotates the cube along the xaxis, ie
  146.     hold the right hand side of the cube and rotate your hand
  147.     clockwise 10 degrees.
  148.  
  149.     The second number (20) rotates the cube along the yaxis, ie
  150.     hold the top of the cube and rotate it 20 degrees clockwise.
  151.  
  152.     The third number is currently ignored.
  153.  
  154.     The default setting is 60 50 0.
  155.  
  156. 4 VIEW
  157.     VIEW x y p
  158.  
  159.     Sets the perspective, this is where the cube gets smaller
  160.     as the lines dissappear towards infinity.
  161.  
  162.     x and y are the position of infinity on your screen.
  163.     p is the degree of perspective, 0 = no perspective
  164.     and with 1 the back edge of the box will be touching
  165.     infinitiy.  Good values are between 0 and 0.6
  166.  
  167. 4 TOP
  168.     TOP OFF   LSTYLE n  COLOR c
  169.  
  170.     Sets the features of the top of the surface.
  171.  
  172.     By default the top is on.
  173.  
  174.     (see also UNDERNEATH, XLINES, YLINES)
  175.  
  176. 4 UNDERNEATH
  177.     UNDERNEATH OFF   LSTYLE n  COLOR c
  178.  
  179.     Sets the features of the under side of the surface.
  180.  
  181.     By default the underneath is off.
  182.  
  183.     (see also TOP, XLINES, YLINES)
  184.  
  185. 4 SKIRT
  186.     SKIRT ON
  187.  
  188.     Draws a skirt from the edge of the surface to ZMIN.
  189.  
  190. 4 XLINES
  191.     XLINES OFF
  192.  
  193.     Stops SURF from drawing lines of constant X.
  194.  
  195. 4 YLINES
  196.     YLINES OFF
  197.  
  198.     Stops SURF from drawing lines of constant Y.
  199.  
  200. 4 POINTS
  201.     POINTS myfile.dat
  202.  
  203.     Reads in a data file which must have 3 columns (x,y,z)
  204.  
  205.     This is then used for plotting markers and
  206.     rise and drop lines.
  207.  
  208. 4 MARKER
  209.     MARKER circle HEI v COLOR c
  210.  
  211.     Draws markers at the co-ordinates read from the POINTS file.
  212.  
  213. 4 DROPLINES
  214.     DROPLINES COLOR c LSTYLE n
  215.  
  216.     Draws lines from the co-ordinates read from the POINTS file
  217.     down to zmin.
  218.  
  219. 4 RISELINES
  220.     RISELINES COLOR c LSTYLE n
  221.  
  222.     Draws lines from the co-ordinates read from the POINTS file
  223.     up to zmax.
  224.  
  225. 4 BACK
  226.     BACK ZSTEP v YSTEP v LSTYLE COLOR c NOHIDDEN
  227.  
  228.     Draws a grid on the back face of the cube.
  229.  
  230.     By default hidden lines are removed but NOHIDDEN will
  231.     stop this from happenning.
  232.  
  233. 4 BASE
  234.     BASE XSTEP v YSTEP v LSTYLE COLOR c NOHIDDEN
  235.  
  236.     Draws a grid on the base of the cube.
  237.  
  238.     By default hidden lines are removed but NOHIDDEN will
  239.     stop this from happenning.
  240.  
  241. 4 RIGHT
  242.     BACK ZSTEP v XSTEP v LSTYLE COLOR c NOHIDDEN
  243.  
  244.     Draws a grid on the right face of the cube.
  245.  
  246.     By default hidden lines are removed but NOHIDDEN will
  247.     stop this from happenning.
  248.